<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Percepio Trace Recorder: Trace Entry Table APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Percepio Trace Recorder<span id="projectnumber">&#160;v4.9.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__trace__entry__table__apis.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Trace Entry Table APIs<div class="ingroups"><a class="el" href="group__trace__recorder__apis.html">Trace Recorder APIs</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTraceEntry.html">TraceEntry</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gacb13b5504dd24ed818e08176ae443ea9"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structTraceEntry.html">TraceEntry</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__entry__table__apis.html#gacb13b5504dd24ed818e08176ae443ea9">TraceEntry_t</a></td></tr>
<tr class="separator:gacb13b5504dd24ed818e08176ae443ea9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga2815314154dd735c7e422ced74de1666"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__entry__table__apis.html#ga2815314154dd735c7e422ced74de1666">xTraceEntryCreate</a> (TraceEntryHandle_t *pxEntryHandle)</td></tr>
<tr class="memdesc:ga2815314154dd735c7e422ced74de1666"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates trace entry.  <br /></td></tr>
<tr class="separator:ga2815314154dd735c7e422ced74de1666"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae1a1f6bc7d62a5325f0c96dde57b38c2"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__entry__table__apis.html#gae1a1f6bc7d62a5325f0c96dde57b38c2">xTraceEntryDelete</a> (TraceEntryHandle_t xEntryHandle)</td></tr>
<tr class="memdesc:gae1a1f6bc7d62a5325f0c96dde57b38c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deletes trace entry.  <br /></td></tr>
<tr class="separator:gae1a1f6bc7d62a5325f0c96dde57b38c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5d6b6b5cb0e383560f4412860ad22e97"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__entry__table__apis.html#ga5d6b6b5cb0e383560f4412860ad22e97">xTraceEntryFind</a> (const void *const pvAddress, TraceEntryHandle_t *pxEntryHandle)</td></tr>
<tr class="memdesc:ga5d6b6b5cb0e383560f4412860ad22e97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds trace entry mapped to object address.  <br /></td></tr>
<tr class="separator:ga5d6b6b5cb0e383560f4412860ad22e97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacd10c5abb485592ecbfa5e6fd9837827"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__entry__table__apis.html#gacd10c5abb485592ecbfa5e6fd9837827">xTraceEntryGetCount</a> (uint32_t *puiCount)</td></tr>
<tr class="memdesc:gacd10c5abb485592ecbfa5e6fd9837827"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the number of entries in the trace entry table.  <br /></td></tr>
<tr class="separator:gacd10c5abb485592ecbfa5e6fd9837827"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaefb9893f3c2841d1ce93b8686e87bc65"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__entry__table__apis.html#gaefb9893f3c2841d1ce93b8686e87bc65">xTraceEntryGetAtIndex</a> (uint32_t index, TraceEntryHandle_t *pxEntryHandle)</td></tr>
<tr class="memdesc:gaefb9893f3c2841d1ce93b8686e87bc65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets trace table entry at index.  <br /></td></tr>
<tr class="separator:gaefb9893f3c2841d1ce93b8686e87bc65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabbc4a177d8effc6ba6ca4018790dce8d"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__entry__table__apis.html#gabbc4a177d8effc6ba6ca4018790dce8d">xTraceEntrySetSymbol</a> (const TraceEntryHandle_t xEntryHandle, const char *szSymbol, uint32_t uiLength)</td></tr>
<tr class="memdesc:gabbc4a177d8effc6ba6ca4018790dce8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets symbol for entry.  <br /></td></tr>
<tr class="separator:gabbc4a177d8effc6ba6ca4018790dce8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="gacb13b5504dd24ed818e08176ae443ea9" name="gacb13b5504dd24ed818e08176ae443ea9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacb13b5504dd24ed818e08176ae443ea9">&#9670;&#160;</a></span>TraceEntry_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structTraceEntry.html">TraceEntry</a> <a class="el" href="group__trace__entry__table__apis.html#gacb13b5504dd24ed818e08176ae443ea9">TraceEntry_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Trace Entry Structure </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga2815314154dd735c7e422ced74de1666" name="ga2815314154dd735c7e422ced74de1666"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2815314154dd735c7e422ced74de1666">&#9670;&#160;</a></span>xTraceEntryCreate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceEntryCreate </td>
          <td>(</td>
          <td class="paramtype">TraceEntryHandle_t *&#160;</td>
          <td class="paramname"><em>pxEntryHandle</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates trace entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">pxEntryHandle</td><td>Pointer to uninitialized trace entry handle.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gae1a1f6bc7d62a5325f0c96dde57b38c2" name="gae1a1f6bc7d62a5325f0c96dde57b38c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae1a1f6bc7d62a5325f0c96dde57b38c2">&#9670;&#160;</a></span>xTraceEntryDelete()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceEntryDelete </td>
          <td>(</td>
          <td class="paramtype">TraceEntryHandle_t&#160;</td>
          <td class="paramname"><em>xEntryHandle</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Deletes trace entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xEntryHandle</td><td>Pointer to initialized trace entry handle.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga5d6b6b5cb0e383560f4412860ad22e97" name="ga5d6b6b5cb0e383560f4412860ad22e97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d6b6b5cb0e383560f4412860ad22e97">&#9670;&#160;</a></span>xTraceEntryFind()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceEntryFind </td>
          <td>(</td>
          <td class="paramtype">const void *const&#160;</td>
          <td class="paramname"><em>pvAddress</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceEntryHandle_t *&#160;</td>
          <td class="paramname"><em>pxEntryHandle</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Finds trace entry mapped to object address. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">pvAddress</td><td>Address of object. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pxEntryHandle</td><td>Pointer to uninitialized trace entry handle.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaefb9893f3c2841d1ce93b8686e87bc65" name="gaefb9893f3c2841d1ce93b8686e87bc65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaefb9893f3c2841d1ce93b8686e87bc65">&#9670;&#160;</a></span>xTraceEntryGetAtIndex()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceEntryGetAtIndex </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>index</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceEntryHandle_t *&#160;</td>
          <td class="paramname"><em>pxEntryHandle</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets trace table entry at index. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Entry index. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pxEntryHandle</td><td>Pointer to uninitialized trace entry handle.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gacd10c5abb485592ecbfa5e6fd9837827" name="gacd10c5abb485592ecbfa5e6fd9837827"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacd10c5abb485592ecbfa5e6fd9837827">&#9670;&#160;</a></span>xTraceEntryGetCount()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceEntryGetCount </td>
          <td>(</td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>puiCount</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the number of entries in the trace entry table. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">puiCount</td><td>Count.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gabbc4a177d8effc6ba6ca4018790dce8d" name="gabbc4a177d8effc6ba6ca4018790dce8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabbc4a177d8effc6ba6ca4018790dce8d">&#9670;&#160;</a></span>xTraceEntrySetSymbol()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceEntrySetSymbol </td>
          <td>(</td>
          <td class="paramtype">const TraceEntryHandle_t&#160;</td>
          <td class="paramname"><em>xEntryHandle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>szSymbol</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>uiLength</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets symbol for entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xEntryHandle</td><td>Pointer to initialized trace entry handle. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">szSymbol</td><td>Pointer to symbol string, set by function </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uiLength</td><td>Symbol length</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
  </ul>
</div>
</body>
</html>
